Dokumentacja MAIL REST API 1.0

POST aliases/<domain>/<name>

Opis
Dodanie nowego aliasu pocztowego.
Sygnatura polecenia
  • Metoda żądania - POST
  • Ścieżka żądania (URL PATH) - parametry identyfikujące nowy alias pocztowy
  • Ciało żądania - wszystkie wymagane parametry modyfikujące dla aliasu pocztowego
  • Ciało odpowiedzi - wszystkie parametry opisujące nowy alias pocztowy
Parametry ścieżki:
(string) domain
wymagany Nazwa domeny w obrębie której znajdować się ma nowy alias.
przykładowa wartość: demo.kei.pl
(string) name
wymagany Nazwa dodawanego aliasu pocztowego.
przykładowa wartość: nowyalias
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - Dopuszczone po jednym wystąpieniu w ciągu symboli '/', '.' oraz '-'
  • - Pole może mieć najwyżej 32 znaki / znaków
Parametry modyfikujące:
target
wymagany Pełny adres e-mail np. stefan@domena.pl.
Konto docelowe to adres e-mail, na który będzie przekierowana poczta wysyłana na adres aliasu.
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - W polu można podać albo poprawną nazwę adresu email (z dopuszczonym znakiem '+' w identyfikatorze użytkownika) lub nazwę konta FTP.
Parametry odpowiedzi:
email Pełen adres pocztowy aliasu.
Przykładowe zapytanie:
POST https://as27.demo.kei.pl/v1/aliases/demo.kei.pl/nowyalias
 parametry:
{ "target":"postmaster@demo.kei.pl" }
Przykładowa odpowiedź:
{
    "name":"nowyalias",
    "domain":"demo.kei.pl",
    "email":"nowyalias@demo.kei.pl",
    "target":"postmaster@demo.kei.pl"
}